home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / tbag / tb060.dms / tb060.adf / Docs / bBase.docs < prev    next >
Text File  |  1991-09-20  |  10KB  |  280 lines
  1.                                bBase II
  2.                                ========
  3.  
  4. Why bBase II?  Just my initials.  No delusions of grandeur in my family.
  5.  
  6. bBase is a full-featured, intuitionized, fast and, I think you will agree,
  7. a quite easy to use database program.  What it does is store, sort, sift,
  8. and search for information, (but it won't dial your telephone).
  9.  
  10. Once a database has been loaded from disk, all modifications are done in 
  11. RAM:, and will NOT be permanently saved until the database is Saved to disk.
  12. This can be done using the Menu, the Function Keys, or upon Quiting.
  13.  
  14. All functions of bBase may be accessed from either Function Keys or Menus.
  15. It multi-tasks extremely well, as it does not burn up CPU time while not 
  16. performing operations.
  17.  
  18. Care should be taken not to access Menu items while the requester is open,
  19. as inappropriate items may not always be ghosted.  This program is written
  20. in BASIC, compiled with the HiSoft BASIC Professional compiler - 
  21. an excellent compiler with some limitations.
  22. The MENU OFF statement is one of those limitations.
  23.  
  24. bBase uses two requesters, the ARP requester for filenames, and my
  25. own for general input.  This requester has full editing capabilities.
  26. It may be blanked at any time by pressing <Alt-X>.  Also, any time the
  27. requester is open, pressing <Escape> will close it.
  28.  
  29.  
  30.                                 MENUS
  31.                                 -----
  32.  
  33. bBase is best described by the operation of the Menus.
  34.  
  35.  
  36. Project Menu
  37. ------------
  38.  
  39. Create a New Database  (F1)
  40.  
  41.   This will bring up the ARP file requester, asking for a name for your new
  42.   database.  Any legal path name of 20 characters or less will do.
  43.   The requester will then ask how many fields the new database will require.
  44.   bBase will accept up to 9 fields, each field Title being a maximum of 
  45.   19 characters long.  If an existing database has been altered, you will 
  46.   be asked if you want to Save it before creating a new one.
  47.   bBase will then build the Template (or list of titles) for the database.
  48.   A "(1)" will appear, along with the requester.  Enter the title of your
  49.   first field, ie. Last Name, First Name, Company, Address, or anything else.
  50.   When it is correct, hit <Return>, and a "(2)" will appear with the 
  51.   requester.  Enter the title of the second field.  Enter all field titles.
  52.   The screen will now show all field titles, an Instruction Box, the 
  53.   File Name as first entered, a blank data area, and the Record Number.  
  54.   At this time, the Record Number will be "1".
  55.  
  56.   The Instruction Box will instruct you to press "<Return> to Enter Data".
  57.   Do so, and the requester will appear in the first field.  Enter the data. 
  58.   A data entry may be a maximum of 46 characters long.  When it is correct, 
  59.   hit <Return> again, and the requester will move to the second field.  
  60.   When all fields are complete, the Record Number will indicate "2", and the
  61.   data field will blank, in prepatation for the entry of the second record.
  62.   Hitting <Return> again will start the process of entering data into the 
  63.   second record.  Complete all records in this manner.  
  64.   There is no limit to the number of records.  (See the 'Change' Menu).
  65.  
  66.  
  67.                                   -2-
  68.  
  69.   At any time (unless a requester is open), pressing the Cursor Up key will 
  70.   take you directly to the First Record.  The Cursor Down key will display 
  71.   the Last Record (with any information in it), the Cursor Left key the 
  72.   Previous numerical Record, and Cursor Right will show the Next Record.  
  73.   You can also move through the records using the mouse (See Screen Gadgets).
  74.  
  75.   The VERY last record is always blank, which is where additional records 
  76.   may be entered.  This blank record is accessed by pressing Cursor Right
  77.   while the Last Record is displayed.
  78.  
  79.  
  80. Open an Existing Database  (F2)
  81.  
  82.   If you have previously created a database, and the "Database_name.bbase" 
  83.   file is stored on a disk, then use this item to access that database.  
  84.   If an existing database has been altered, you will be asked if you want to 
  85.   Save it before loading another.  Enter the path to the database file
  86.   in the requester, and that database will be retrieved and shown on screen.
  87.   Only files having the extension ".bbase" will be accepted.
  88.   Use the Cursor keys or mouse to move about the database.
  89.  
  90.   While a record is displayed, the Information Box will instruct you to
  91.   press "<Return> to Change Data".  Do so, and the requester will appear 
  92.   in the first field, with that field's data.  <Return> down to the field 
  93.   you want to change, make the changes, and <Return> through all fields.
  94.   The altered record will be displayed.
  95.  
  96.  
  97. Save the Current Database  (F3)
  98.  
  99.   Saves the database to disk under the name shown, without confirmation. 
  100.   The bBase file will have the extension ".bbase" automatically appended.
  101.  
  102.  
  103. Save As
  104.  
  105.   You will be prompted for a name to Save the database.
  106.   The ".bbase" extension will be automatically appended.
  107.  
  108.  
  109. About
  110.  
  111.   The usual stuff.
  112.  
  113.  
  114. Quit  (Escape)
  115.  
  116.   If the database has been altered, you will be asked if you want to Save it
  117.   before Quiting.
  118.  
  119.   
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.                                   -3-
  134.  
  135. Sort Menu
  136. ---------
  137.  
  138.   You may sort the records in the database based on the data in any field.
  139.   The Sort routine seems to be fairly efficient for a BASIC program.
  140.   It will sort 100 records in less than 15 seconds on a standard A2000.
  141.  
  142.  
  143. Incremental Sort  (F4)
  144.  
  145.   The requester will ask which field you want to sort on.  The records will
  146.   be incrementally sorted on that field, and Record Number 1 of the new list
  147.   will be shown.
  148.  
  149.  
  150. Decremental Sort  (F5)
  151.  
  152.   Same as above, but records are sorted and displayed from Z-A, or 9-0.
  153.  
  154.  
  155.  
  156. Search Menu
  157. -----------
  158.  
  159. Select Search Criteria  (F6)
  160.  
  161.   The requester will appear in the first field of a blank record.  
  162.   <Return> down to the field that contains the data you want to search for.  
  163.   Enter the search string in that field.  A search string may be entered in
  164.   more than one field.  <Return> through all the fields.  All records that
  165.   match ALL the search criteria will be displayed, one by one. When a record
  166.   is found, you may Print it, cancel the Search, or continue searching.
  167.  
  168.  
  169.  
  170. Change Menu
  171. -----------
  172.  
  173. Template Titles
  174.  
  175.   Use this item to change the Template, ie. the Titles of your fields.
  176.   The NUMBER of fields may not be changed.  The data itself is unaffected
  177.   by this procedure.
  178.  
  179.  
  180. Maximum No. of Records
  181.  
  182.   If your database becomes full, you will either have to Delete some records,
  183.   or increase the maximum number of records the database will hold.
  184.   The maximum number is 99 records, until you change it.
  185.   Just select this item, and follow the prompts.
  186.  
  187.   Note: IF you are making the database SMALLER, you WILL LOSE the data 
  188.         stored in those records with a number higher than your new database
  189.         size (naturally).  The other records will be preserved.
  190.  
  191.   Note: The database size may be changed only ONCE per invokation of bBase.
  192.         Attempting another resize crashes the program.  For this reason, the
  193.         Change "Maximum No. of Records" feature is disabled after the 
  194.         database size has been changed.  To change the size again, simply
  195.         Quit the program, and re-load it.  I don't think this will be a 
  196.         problem, as most people will probably never have occasion to change
  197.         it even once.
  198.  
  199.                                   -4-
  200.  
  201. Print Menu
  202. ----------
  203.  
  204. Displayed Record  (F8)
  205.  
  206.   This item will send the displayed record to the PRT: device.
  207.  
  208.  
  209. The Whole Database  (F9)
  210.  
  211.   This item will send the entire database to the PRT: device.
  212.  
  213.  
  214.  
  215. Delete Menu
  216. -----------
  217.  
  218. Displayed Record  (F10)
  219.  
  220.   After confirmation, the record currently displayed is Deleted.
  221.  
  222.  
  223.  
  224.                             SCREEN GADGETS
  225.                             --------------
  226.  
  227. The Information Box at the bottom of the screen contains a           / \
  228. gadget that looks something like that shown a the right.             | |
  229. This gadget represents the Cursor Keys, and you can move          <== G ==> 
  230. about the database using these gadgets and the mouse                 | |
  231. instead of the Cursor Keys if you so desire.  Clicking on            \ /
  232. the Up Arrow will take you directly to the First Record.
  233. Clicking on the Down Arrow will take you to the Last Record, (except for the
  234. blank one used to enter a new record).  The Left Arrow will show the Previous
  235. numerical Record to the one currently displayed, and the Right Arrow
  236. will show the Next Record.  If the Last Record is currently displayed, this
  237. will take you to the blank record, where a new record may be entered.
  238. Clicking on the "G" in the center of the arrows will bring up the requester,
  239. asking for the number of a record to "Goto".  After entering a legal number,
  240. the requested record will be displayed.
  241.  
  242.  
  243.  
  244.                             EXAMPLE DATABASE
  245.                             ----------------
  246.  
  247. There is an example database included in this package.  Everyone uses the
  248. Name and Address example, so I opted for something different.  The file
  249. "Recipes.bbase" is a sample database showing one way of keeping track of 
  250. recipes, without having to re-type them all.  It merely shows where they can
  251. be found when needed.  With this database you can Sort the recipes by Name,
  252. Catagory, or anything else.  You can Search for all recipes containing a 
  253. listed ingredient, recipes you have already served to given people, or just 
  254. the name of the recipe if you have forgotten which of your 647 recipe books 
  255. it is in.  I have found this to be very useful.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.                                   -5-
  266.  
  267.                              REQUIREMENTS
  268.                              ------------
  269.  
  270. The "arp.library" will have to be in your libs: directory, because of the
  271. ARP file requester - but everyone should have that there by now, right?
  272.  
  273.  
  274. Comments and bug reports are welcome.
  275. Name and address in "About".
  276.  
  277. Hope someone finds this useful.
  278.  
  279. Bob
  280.